
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SNAPSHOT.CGI</TITLE>
</HEAD><BODY>
<H1>SNAPSHOT.CGI</H1>
Section: User Commands  (1)<BR>Updated: Version 4.3.13:  7 Jan 2014<BR><A HREF="#index">Index</A>
<A HREF="../index.html">Return to Main Contents</A><HR>

<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

snapshot.cgi - CGI program to rebuild the Xymon webpages for a specific point in time.
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<B>snapshot.cgi</B>

<P>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>

<B>snapshot.cgi</B>
is invoked as a CGI script via the snapshot.sh CGI wrapper.
It rebuilds the Xymon web pages to the look they had 
at a particular point in time, based upon the historical information
logged about events.
<P>
snapshot.cgi is passed a QUERY_STRING environment variable with the
following parameters:
<P>
<BR>&nbsp;&nbsp;&nbsp;mon&nbsp;(Start&nbsp;month&nbsp;of&nbsp;the&nbsp;snapshot)
<BR>&nbsp;&nbsp;&nbsp;day&nbsp;(Start&nbsp;day-of-month&nbsp;of&nbsp;the&nbsp;snapshot)
<BR>&nbsp;&nbsp;&nbsp;yr&nbsp;&nbsp;(Start&nbsp;year&nbsp;of&nbsp;the&nbsp;snapshot)
<BR>&nbsp;&nbsp;&nbsp;hour&nbsp;(Start&nbsp;hour&nbsp;of&nbsp;the&nbsp;snapshot)
<BR>&nbsp;&nbsp;&nbsp;min&nbsp;&nbsp;(Start&nbsp;minute&nbsp;of&nbsp;the&nbsp;snapshot)
<BR>&nbsp;&nbsp;&nbsp;sec&nbsp;&nbsp;(Start&nbsp;second&nbsp;of&nbsp;the&nbsp;snapshot)
<P>
The &quot;month&quot; parameters must be specified as the three-letter
english month name abbreviation: Jan, Feb, Mar ...
<P>
&quot;day&quot; must be in the range 1..31; &quot;yr&quot; must be specified 
including century (e.g. &quot;2003&quot;). &quot;hour&quot; must be specified 
using a 24-hour clock.
<P>
All of the processing involved in generating the report is done 
by invoking 
<I><A HREF="../man1/xymongen.1.html">xymongen</A>(1)</I>

with the proper &quot;--snapshot&quot; option.
<P>
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>

<DL COMPACT>
<DT>--env=FILENAME<DD>
Load environment from FILENAME before executing the CGI.
<P>
<DT>xymongen-options<DD>
All options except &quot;--env&quot; are passed on to the 
<I><A HREF="../man1/xymongen.1.html">xymongen</A>(1)</I>

program building the snapshot files.
<P>
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>ENVIRONMENT VARIABLES</H2>

<DL COMPACT>
<DT>XYMONGENSNAPOPTS<DD>
xymongen options passed by default to the snapshot.cgi script. 
This happens in the snapshot.sh CGI wrapper script.
<DT>XYMONHOME<DD>
Home directory of the Xymon server files
<DT>XYMONSNAPDIR<DD>
Directory where generated snapshots are stored. This directory must
be writable by the userid executing the CGI script, typically
&quot;www&quot;, &quot;apache&quot; or &quot;nobody&quot;. Default: $XYMONHOME/www/snap/
<DT>XYMONSNAPURL<DD>
The URL prefix to use when accessing the reports via a browser.
Default: $XYMONWEB/snap
<P>
<P>
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>

<A HREF="../man1/xymongen.1.html">xymongen</A>(1), <A HREF="../man5/hosts.cfg.5.html">hosts.cfg</A>(5), <A HREF="../man5/xymonserver.cfg.5.html">xymonserver.cfg</A>(5)
<P>
<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">OPTIONS</A><DD>
<DT><A HREF="#lbAF">ENVIRONMENT VARIABLES</A><DD>
<DT><A HREF="#lbAG">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 09:25:35 GMT, January 07, 2014
</BODY>
</HTML>
